home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat4 / pmrules.z / pmrules
Text File  |  1997-04-03  |  11KB  |  199 lines
  1.  
  2.  
  3.  
  4. PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))                                                          PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmrrrruuuulllleeeessss - template file format for ppppmmmmrrrruuuulllleeeessss(1)
  10.  
  11. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  12.      ppppmmmmrrrruuuulllleeeessss(1) allows restricted editing of ppppmmmmiiiieeee(1) rules via an intermediate
  13.      representation known as a template.  A template is a parameterized
  14.      description of a rule.  The template describes which parts of the rule a
  15.      user may change and also provides information for ppppmmmmrrrruuuulllleeeessss to do some type
  16.      checking.
  17.  
  18.      A template file consists of a header, some optional global parameters and
  19.      a list of rule definitions each with optional local parameters.
  20.  
  21.      A line beginning with #### is considered a comment.  Strings are delimited
  22.      by double quotes ("""") and newlines within strings are preserved.
  23.  
  24. HHHHeeeeaaaaddddeeeerrrr
  25.      The header should look like this:
  26.  
  27.      ####!!!!////uuuussssrrrr////ssssbbbbiiiinnnn////ppppmmmmrrrruuuulllleeeessss
  28.      #### ppppmmmmrrrruuuulllleeeessss 1111....0000
  29.  
  30.      And be followed by a rrrruuuulllleeeesssseeeetttt definition of the form
  31.  
  32.      rrrruuuulllleeeesssseeeetttt _n_a_m_e hhhheeeellllpppp====_h_e_l_p_t_e_x_t;;;;
  33.  
  34.      Where _n_a_m_e is a string or an identifier (following the standard C
  35.      conventions) and _h_e_l_p_t_e_x_t is a string containing a description of what
  36.      the rules described by this set of templates are designed to do.  This
  37.      will appear at the top of the help text in the Edit Global Parameters
  38.      dialog box in ppppmmmmrrrruuuulllleeeessss so it should be something that the user editing the
  39.      templates will understand.  ppppmmmmrrrruuuulllleeeessss does not do line breaking, so
  40.      sensible use of newlines within the _h_e_l_p_t_e_x_t is encouraged.
  41.  
  42. PPPPaaaarrrraaaammmmeeeetttteeeerrrrssss
  43.      Parameter definitions (both global and local) have the following form:
  44.  
  45.      _n_a_m_e _v_a_l_u_e _a_t_t_r_l_i_s_t;;;;
  46.  
  47.      Where an _n_a_m_e is an identifier (following the standard C conventions),
  48.      and _a_t_t_r_l_i_s_t consists of a list of whitespace separated _a_t_t_r_i_b_u_t_e====_v_a_l_u_e
  49.      pairs.
  50.  
  51.      The following _a_t_t_r_i_b_u_t_es are defined for parameters:
  52.  
  53.      ttttyyyyppppeeee Defines a type for the parameter.  ppppmmmmrrrruuuulllleeeessss may be able to validate
  54.           user input for simple types such as integers.  For more complex
  55.           types such as metric instance lists, checking may not be possible
  56.           (e.g. if a host is down the set of valid instances is unknown).
  57.           Valid values for ttttyyyyppppeeee are:  ssssttttrrrriiiinnnngggg, ssssttttrrrroooonnnngggg (a non-null string),
  58.           ddddoooouuuubbbblllleeee, iiiinnnntttt, uuuunnnnssssiiiiggggnnnneeeedddd, %%%% (a percentage), hhhhoooosssstttt, hhhhoooossssttttlllliiiisssstttt, iiiinnnnsssstttt (a
  59.           single valid instance of a performance metric), iiiinnnnssssttttlllliiiisssstttt (a list of
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))                                                          PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))
  71.  
  72.  
  73.  
  74.           iiiinnnnsssstttt), ssssccccrrrriiiipppptttt (a executable program or shell script, as used in the
  75.           action part of a ppppmmmmiiiieeee rule), ssssccccrrrriiiippppttttlllliiiisssstttt (a list of ssssccccrrrriiiipppptttt).  If no
  76.           type is specified, the default is ssssttttrrrriiiinnnngggg.
  77.  
  78.      ddddiiiissssppppllllaaaayyyy
  79.           Valid values are yyyyeeeessss, display the parameter for the user (the
  80.           default) and nnnnoooo, hide the parameter.
  81.  
  82.      mmmmooooddddiiiiffffyyyy
  83.           Valid values are yyyyeeeessss, allow the user to modify the parameter (the
  84.           default) and nnnnoooo, the parameter is a constant.
  85.  
  86.      ddddeeeeffffaaaauuuulllltttt
  87.           Specifies a default (fallback) value for the parameter.
  88.  
  89.      mmmmeeeettttrrrriiiicccc
  90.           The value is the name of a performance metric with an associated
  91.           instance domain (see PPPPMMMMAAAAPPPPIIII(3)) for the parameter if it is of type
  92.           iiiinnnnsssstttt or iiiinnnnssssttttlllliiiisssstttt.
  93.  
  94.      hhhheeeellllpppp The value is a string describing the parameter.  This is the help
  95.           text for the parameter displayed by ppppmmmmrrrruuuulllleeeessss.  ppppmmmmrrrruuuulllleeeessss does not do
  96.           line breaking, so sensible use of newlines within the help string is
  97.           encouraged.
  98.  
  99.      Some parameters are reserved by the ppppmmmmiiiieeee rule generator within
  100.      ppppmmmmrrrruuuulllleeeessss(1).  Use of parameters with the same name for other purposes is
  101.      unwise.  Just as with normal parameters, a definition in a template will
  102.      take precedence over a global definition.  The reserved parameters are:
  103.  
  104.      aaaaccccttttiiiioooonnnnssss
  105.           A list of semicolon separated shell commands to invoke when a rule
  106.           fires.  Each shell command is preceded by a yyyy or nnnn the a space to
  107.           indicate whether the command (action) is enabled or disabled
  108.           (respectively).  If a shell command begins with a slash (``////'') it
  109.           is taken to be an absolute path otherwise the shell command is
  110.           expected to exist in ////vvvvaaaarrrr////ppppccccpppp////ccccoooonnnnffffiiiigggg////ppppmmmmiiiieeee.  Two special parameters
  111.           rrrruuuulllleeee and hhhhoooosssstttt are defined for actions.  rrrruuuulllleeee is the name of the rule
  112.           that invoked the action and hhhhoooosssstttt is the host for which the rule
  113.           fired.  It is normal for a template to define an action and a
  114.           corresponding string parameter both named uuuusssseeeerrrr aaaaccccttttiiiioooonnnn which a
  115.           ppppmmmmrrrruuuulllleeeessss user can modify to perform arbitrary actions.
  116.  
  117.      hhhhoooossssttttssss
  118.           The list of hosts for which a rule should be evaluated.
  119.  
  120.      ddddeeeellllttttaaaa
  121.           The frequency with which ppppmmmmiiiieeee should evaluate the rule.  If no delta
  122.           is specified (either locally or globally), ppppmmmmiiiieeee will use a default.
  123.           The default can be overridden on the ppppmmmmiiiieeee command line when it is
  124.           run.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))                                                          PPPPMMMMRRRRUUUULLLLEEEESSSS((((4444))))
  137.  
  138.  
  139.  
  140.      hhhhoooollllddddooooffffffff
  141.           This is the hold off time ppppmmmmiiiieeee uses to prevent a rule from firing
  142.           too often.
  143.  
  144. RRRRuuuulllleeee DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss
  145.      A list of one or more rule definitions should appear.  Rule definitions
  146.      have the following form:
  147.  
  148.      rrrruuuulllleeee _n_a_m_e _r_u_l_e__a_t_t_r_s;;;;
  149.  
  150.      Any local parameter definitions for the rule should follow immediately
  151.      after it.
  152.  
  153.      _n_a_m_e should be a string or an identifier (following the standard C
  154.      conventions).  It is best to choose a meaningful name, since the rule
  155.      names are what the user sees when browsing lists of templates, e.g. "main
  156.      memory exhaustion" rather then "nomem".  _r_u_l_e__a_t_t_r_s consists of a list of
  157.      whitespace separated _a_t_t_r_i_b_u_t_e====_v_a_l_u_e pairs.
  158.  
  159.      The following _a_t_t_r_i_b_u_t_es are defined for rules:
  160.  
  161.      eeeennnnaaaabbbblllleeee
  162.           Determines whether ppppmmmmiiiieeee will evaluate the rule (yyyyeeeessss, the default) or
  163.           not (nnnnoooo).
  164.  
  165.      ccccoooonnnndddd A string containing the condition for the ppppmmmmiiiieeee rule.  Any references
  166.           to parameters in the string should be enclosed in $$$$ signs, e.g. "...
  167.           > $$$$_t_h_r_e_s_h_o_l_d$$$$ ..." will substitute the _t_h_r_e_s_h_o_l_d parameter in the
  168.           condition.
  169.  
  170.      hhhheeeellllpppp This will appear at the top of the help text in the Edit Template
  171.           dialog box in ppppmmmmrrrruuuulllleeeessss so it should be a general description of what
  172.           the rule does.  Don't forget that parameters get their own help
  173.           text.
  174.  
  175. FFFFIIIILLLLEEEESSSS
  176.      ////vvvvaaaarrrr////ppppccccpppp////ccccoooonnnnffffiiiigggg////ppppmmmmrrrruuuulllleeeessss////*
  177.                              template files supplied with the Performance Co-
  178.                              Pilot (PCP) and its various add-on products.
  179.      ////vvvvaaaarrrr////ppppccccpppp////ccccoooonnnnffffiiiigggg////ppppmmmmiiiieeee////*  scripts for standard pmie actions supplied with
  180.                              the Performance Co-Pilot (PCP) and its various
  181.                              add-on products.
  182.  
  183. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  184.      PPPPMMMMAAAAPPPPIIII((((3333)))),,,, ppppmmmmiiiieeee(1) and ppppmmmmrrrruuuulllleeeessss(1).
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.